GetAllCaptionParagraphs

Returns all caption paragraphs of the specified type from the current document.

Syntax

expression.GetAllCaptionParagraphs(sCaption);

expression - A variable that represents a ApiDocument class.

Parameters

Name	Required/Optional	Data type	Default	Description
sCaption	Required	CaptionLabel	string

Returns

ApiParagraph[]

Example

This example shows how to get all caption paragraphs of the specified type from the current document.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let drawing = Api.CreateImage("https://api.onlyoffice.com/content/img/docbuilder/examples/coordinate_aspects.png", 60 * 36000, 35 * 36000);
paragraph.AddDrawing(drawing);
paragraph = Api.CreateParagraph();
doc.Push(paragraph);
paragraph.AddCaption("", "Figure", false, "Arabic", false, undefined, "hyphen");
let captionParagraphs = doc.GetAllCaptionParagraphs("Figure");
captionParagraphs[0].SetCaps(true);